home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d971.lha / QDisk / QDisk.doc < prev    next >
Text File  |  1994-01-22  |  13KB  |  290 lines
  1. ----------------------------------------------------------------------
  2.  
  3.   Q D I S K (Query  Disk)
  4.   ~~~~~~~~~~~~~~~~~~~~~~~
  5.   Version      : 2.01
  6.   Written By   : Norman Baccari
  7.   Developement : SAS/C V6.51
  8.   Program Icon : JOHN WASZCZAK
  9.   Interface    : GadToolsBox V2.0 by JAN VAN DEN BAARD
  10.   COPYRIGHT    : © 1993-94 Norman J. Baccari
  11.   Distribution : FREEWARE. "Its Not PD, But Its FREE!"
  12.  
  13. ----------------------------------------------------------------------
  14.     DISTRIBUTION
  15. ----------------------------------------------------------------------
  16.  NO WARRANTIES ARE MADE.  ALL USE IS AT YOUR OWN RISK.  NO LIABILITY
  17.                       OR RESPONSIBILITY IS ASSUMED.
  18.  
  19. QDisk  is  NOT public domain.  QDisk may be freely distributed as long
  20. as the there are no charges other than for media and / or mailing, the
  21. program  is  not  used  for commercial gain or included as part of any
  22. other software without permission from the author, and the program and
  23. the   documentaion   file  remain  intact,  unalterd  and  distributed
  24. together. QDisk is  classed as FREEWARE.  All I ask,is that you let me
  25. know  of any problems or bugs you might encounter, or just let me know
  26. what features you think QDisk should have.
  27.  
  28. The following files make up the distribution for QDisk...
  29.  
  30.   QDisk                     Main program.
  31.   QDisk.doc                 Standard text documentation.
  32.   QDisk.guide               AmigaGuide format documentation.
  33.  
  34. ----------------------------------------------------------------------
  35.     WHAT IS QDISK?
  36. ----------------------------------------------------------------------
  37. QDisk  provides  you  with the ability to monitor, from WorkBench, the
  38. space  usage of all AMIGA DOS disk volumes that are currently mounted.
  39. QDisk  can also send you a notification when usage exceeds a limit set
  40. by  you.   For  the  notification, you  have  the option of a standard
  41. requester or a recoverable alert.  QDisk requires WB2.04 or higher.
  42.  
  43. ----------------------------------------------------------------------
  44.     NEW FOR QDISK V2.00
  45. ----------------------------------------------------------------------
  46. ° QDisk  has  almost  been  completely  re-written, hence the jump in
  47.   version from  1.1 to 2.00.
  48. ° Complete preference editor replaces all ToolTypes.
  49. ° Option to start Iconified.
  50. ° Window positions can now be set with a snapshot.
  51. ° ListView format now shows both Device & Volume name.
  52. ° Uses menu instead of gadgets for less cluttered display.
  53. ° Main window can now be sized.
  54. ° Notification if %usage is exceeded or free space falls too low.
  55.  
  56. ----------------------------------------------------------------------
  57.     QDISK MAIN WINDOW
  58. ----------------------------------------------------------------------
  59. To  use QDisk simply double click on the program icon or you can place
  60. QDisk  in  you  WBStartUp drawer.  You will then be presented with the
  61. main  window  on  the  WorkBench.   In  it  will  be a list of volumes
  62. currently  mounted.   The  Device/Volume  name  is  displayed with its
  63. usage.   By  simply  clicking once on a Device/Volume, a detail window
  64. will open showing more information on that particular volume.
  65.  
  66. Iconifying QDisk
  67. ~~~~~~~~~~~~~~~~
  68. In  the  upper  right  corner  there is a small square gadget with the
  69. letter  "I"  in it.  Clicking on this will cause QDisk to iconify.  To
  70. un-iconify,  activate  the iconified window by clicking once on it and
  71. then click the right mouse button.
  72.  
  73. Menus
  74. ~~~~~
  75. From the Main window there are 4 menu options...
  76.  
  77.    Preferences     : Calls up preference editor
  78.    Iconify         : Iconify QDisk
  79.    About           : Author/program info
  80.    Quit            : Quit QDisk
  81.  
  82. Keeping Up To Date
  83. ~~~~~~~~~~~~~~~~~~
  84. QDisk  reads  the  systems  DOS  device/volume lists to update itself.
  85. Updates  happen  whenever  a  disk is removed or inserted, or the main
  86. window  is made active.  Optionally, you can set updates to take place
  87. by  activating  the  timer  and  setting  the  timer interval from the
  88. preference editor.
  89.  
  90. ----------------------------------------------------------------------
  91.     QDISK DETAIL WINDOW
  92. ----------------------------------------------------------------------
  93. When  you  select  one  of  the  drives from the main windows listview
  94. gadget  by  clicking on it, you will be presented with a detail window
  95. with  information on the drive you selected.  Across the bottom of the
  96. window  there is a graphic bar that indicates the space usage based on
  97. percent.
  98.  
  99. ----------------------------------------------------------------------
  100.     QDISK PREFERENCE EDITOR
  101. ----------------------------------------------------------------------
  102.  
  103. Window Position
  104. ~~~~~~~~~~~~~~~
  105. This  group  of  gadgets  allows  you  to  set the position of all the
  106. windows.   You  can manually enter values for TopEdge/LeftEdge.  These
  107. values  will  be  used next time you boot QDisk.  Or, if the window is
  108. currently  open,  you  can  take a snapshot of it.  Window height only
  109. applies to the Main Window.  If you try to snapshot a window thats not
  110. open  it  will be ignored.  All windows multi-task so you can have all
  111. the windows open at the same time.
  112.  
  113. AutoUpdate
  114. ~~~~~~~~~~
  115. This  will  cause  QDisk  to  be updated using the timer device at the
  116. interval  that  you  specify  in  seconds.   The minimum interval is 5
  117. seconds,  and  maximum  interval  is  999 seconds.  Updates are always
  118. performed  when  a  disk is inserted or removed, or the main window is
  119. activated.
  120.  
  121. Mark
  122. ~~~~
  123. This  will  cause  QDisk  to place an asterisk to the left side of any
  124. volume  that  equals  or exceeds the percent usage that you specify as
  125. the "Mark at %".  For example, if you specify a mark at 85% any volume
  126. having a percent usage of 85% or more will be marked.
  127.  
  128. Iconify Start
  129. ~~~~~~~~~~~~~
  130. If activated QDisk will start up in an iconified state.
  131.  
  132. Setting Up Notification
  133. ~~~~~~~~~~~~~~~~~~~~~~~
  134. The  greater  part of the gadgets in the preference editor are used to
  135. set  up  how you would like to be notified if space usage exceeds your
  136. requirements.   There  are two listviews, VOLUMES and the NOTIFY LIST.
  137. The  VOLUMES  list  shows the volumes currently mounted from which you
  138. may  select.   The lists are arranged in two columns, the left showing
  139. the  device name and the right showing the volume name.  Clicking on a
  140. volume from the VOLUMES list will make it available to be added to the
  141. NOTIFY  LIST.   When a volume is selected the "ADD" gadget will become
  142. active  and  the  current percent usage and free bytes for that volume
  143. are displayed in the read only gadgets under the VOLUMES list.  If you
  144. then  click on the "ADD" gadget above the VOLUME list then this volume
  145. will  be  inserted  into the NOTIFY LIST.  To remove a volume from the
  146. NOTIFY  LIST,  select  it  by  clicking  on  it  and then click on the
  147. "REMOVE" gadget.  When a volume is added, it is given a set of default
  148. parameters and set to be inactive.  To change these, select the volume
  149. from  the  NOTIFY LIST.  This will activate the gadgets from which you
  150. can  change  these  parameters.   You can be notified based on percent
  151. usage, free bytes left, or both.
  152.  
  153. Notify When Percent Full Exceeds...
  154. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  155. This  indicates  the  percent  usage  at  which  you  would like to be
  156. notified.   If  space  usage  percent is equal to, or exceeds what you
  157. have specified then a notification will be sent.  Setting this to 100%
  158. is like turning it off.
  159.  
  160. Notify When Free Bytes Less Than...
  161. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  162. This  indicates the minimum allowable free space before a notification
  163. is  sent.   If  the  free bytes on a volumes are equal to or less than
  164. what  you  have  specified  then a notification will be sent.  Setting
  165. this to 0 is like turning it off.
  166.  
  167. Notification Type
  168. ~~~~~~~~~~~~~~~~~
  169. You  can  be notified in one of two ways.  An Intuition Requester or a
  170. Recoverable  Alert.   When  a  notify  is  given  using  an  Intuition
  171. Requester you will be able to turn off notification or continue.  From
  172. the  Recoverable Alert, the notification state is automatically turned
  173. off  once  you  click on a mouse button.  From either type, QDisk will
  174. tell  you  the  device/volume  name that triggered the notify, and the
  175. current  percent usage and free bytes on the drive.  Keep in mind that
  176. QDisk  will  NOT  try  to halt a process that may be saving or copying
  177. data to your drive.  Ideally, you should set your notifies to occur at
  178. such  a  time  that  you  can  stop the program that is using up drive
  179. space.
  180.  
  181. Notify State.
  182. ~~~~~~~~~~~~~
  183. This is used to toggle notification between ACTIVE & IN-ACTIVE for the
  184. currently selected volume in the NOTIFY LIST.
  185.  
  186. Timed Notifications.
  187. ~~~~~~~~~~~~~~~~~~~~
  188. Keep  in  mind  that the more volumes you have for active notification
  189. the  longer  it  will  take QDisk to complete its update cycle.  QDisk
  190. first  scans  the AMIGA DOS list and updates its information.  Then it
  191. checks  each  active  volume  you  have  in  the notification list and
  192. compares  your  usage  parameters  with  current usgae for each active
  193. volume.   In  an extreme situation, if your auto update interval was 5
  194. seconds and there were 20 active volumes to be checked for space usage
  195. QDisk  would  be  in a constant update cycle since, by the time it has
  196. finished  its  update  cycle  QDisk will have received another message
  197. from  the timer device to perform an update.  This means QDisk will be
  198. using  CPU  at  a constant rate.  The best approach is to allow a time
  199. period  for  each active volume you expect to be notified.  The length
  200. of time will depend on how fast your system is (I.E. 68000 vs 68040).
  201.  
  202.  
  203. ----------------------------------------------------------------------
  204.     CONTACTING THE AUTHOR
  205. ----------------------------------------------------------------------
  206.     Internet Address...
  207.       normb@gpu.utcc.utoronto.ca
  208.  
  209.     Otherwise Snail Mail Will Do...
  210.        Norman Baccari
  211.        ALGONQUIN SOFTWARE
  212.        35 Walmer Road, Suite 201
  213.        Toronto, Ontario
  214.        CANADA
  215.        M5R 2X3
  216.  
  217.  
  218. ----------------------------------------------------------------------
  219.      QDISK HISTORY
  220. ----------------------------------------------------------------------
  221. **  Jan 1994 v2.01 Program Size : 40564
  222. **  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  223. **   -Rearanged gadgets on prefs editor window and added better label
  224. **    to make it more obvious how the percent/free bytes int gadgets work.
  225. **   -Forgot to put in Busy Pointer when the "About" option is called
  226. **    from the menu. This has been implemented.
  227. **
  228. **  Jan 1994 v2.00 Program Size : 39520
  229. **  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  230. **   -Jumped to version 2.00 from 1.1. (Almost a complete rewrite.)
  231. **   -All versions from 2.00 will use standard version notation.
  232. **   -All tooltypes removed and replaced with a preference editor.
  233. **   -Added as preference the ability to start QDisk Iconified.
  234. **   -Added snapshot feature to position windows from PrefEd.
  235. **   -Set up the ability to be notified when a drive exceeds space usage.
  236. **   -Changed Detail window from using IntuiText type display
  237. **    to GadTools text gadgets.
  238. **   -Main listview format is now a combination of drive/volume Name.
  239. **   -The HASH graph removed.
  240. **   -Changed the ABOUT credits listview to simple & brief
  241. **    system requester. The old way wasn't worth the overhead.
  242. **   -Permanently removed the update button.
  243. **   -New iconify routine uses a seperate window instead of the zip
  244. **    gadget. Activated by gadget in upper right corner above listview.
  245. **   -Replaced main window gadgets with menus.
  246. **   -Main window is now resizable.
  247. **   -Documentation in AmigaGuide Format.
  248. **   -Fixed an enforcer hit caused by NOT using LockDosList().(ouch!)
  249. **
  250. **  Aug 1993 v1.1a Program Size : 31044
  251. **  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  252. **   -MinorBug in InfoWindow. Text and bar graph would be
  253. **   -out of alignment if the screen font was more than
  254. **   -8 points. Made 'Y' coordinates relative to Windows
  255. **   -TopBorder (window->BorderTop). Thanks Scott!
  256. **
  257. **  Jul 1993 v1.1 Program Size : 30860
  258. **  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  259. **   -Removed "OK" gadget from info window.
  260. **   -Removed recessed border in info window
  261. **   -Moved "gas gage" to bottom of info window.
  262. **   -Removed the font drop shadow in info window.
  263. **   -List View is only re-rendered on disk insertion
  264. **     or disk removal.
  265. **   -Auto Update via timer.device toggled on/off
  266. **     with AutoUpdate tool type.
  267. **   -UPDATE_SECONDS Tool type to set UD interval seconds.
  268. **   -New INFO display mode, HASHGRAPH
  269. **   -Rounding added to space usage for better accuracy.
  270. **   -ZOOM_X & ZOOM_Y tool types added for positioning
  271. **     window when zoomed.
  272. **   -Update on IDCMP_WINDOWACTIVE
  273. **   -SHOW tool type defines main display format for boot-up.
  274. **
  275. **  Apr 1993 v1.0
  276. **  ~~~~~~~~~~~~~
  277. **   -Initial public release.
  278. **
  279. **  Mar 1993 v0.04
  280. **  ~~~~~~~~~~~~~~
  281. **   -Versions up to 0.04 are unreleased BETA versions.
  282. **
  283. **  Jan 1992 v0.00
  284. **  ~~~~~~~~~~~~~~
  285. **   -Original program (Called BOOTMSG) was a wb1.3 probe
  286. **   -into device lists based on an article in the april/may
  287. **   -1991 issue of AW Tech Journal. It was never released
  288. **   -as it was experimental, and stayed dormant until it
  289. **   -was given a new life as QDISK.
  290.